Release/2.14.5 #436

mehmet-yoti · 2025-12-01T15:52:36Z

Static Liveness Check Implementation

Overview

This implementation adds support for Static Liveness Check to the Yoti Python SDK, enabling identity verification using a single static image instead of the ZOOM liveness method which requires multiple frames and facemap data.

Features Added

1. Session Creation (Request Side)

Create STATIC Liveness Check

from yoti_python_sdk.doc_scan import RequestedLivenessCheckBuilder

# Build a STATIC liveness check
liveness_check = (
    RequestedLivenessCheckBuilder()
    .for_static_liveness()
    .with_max_retries(3)
    .with_manual_check_never()
    .build()
)

Generated JSON:

{
  "type": "LIVENESS",
  "config": {
    "liveness_type": "STATIC",
    "manual_check": "NEVER",
    "max_retries": 3
  }
}

2. Session Retrieval (Response Side)

Access STATIC Liveness Resources

from yoti_python_sdk.doc_scan import DocScanClient

client = DocScanClient(sdk_id, key_file_path)
session_result = client.get_session(session_id)

# Get all STATIC liveness resources
static_resources = session_result.resources.static_liveness_resources

for resource in static_resources:
    print(f"Resource ID: {resource.id}")
    print(f"Liveness Type: {resource.liveness_type}")
    
    # Access the image and media
    if resource.image and resource.image.media:
        media_id = resource.image.media.id
        media_type = resource.image.media.type
        created = resource.image.media.created
        
        print(f"Media ID: {media_id}")
        print(f"Media Type: {media_type}")

3. Media Content Retrieval

Download STATIC Liveness Image

# Get the first STATIC liveness resource
static_liveness = session_result.resources.static_liveness_resources[0]

# Extract media ID
media_id = static_liveness.image.media.id

# Retrieve the actual image content
media_content = client.get_media_content(session_id, media_id)

# Access the image bytes and MIME type
image_bytes = media_content.content
mime_type = media_content.mime_type  # e.g., "image/jpeg" or "image/png"

# Save to file
with open(f"liveness_image.{mime_type.split('/')[-1]}", "wb") as f:
    f.write(image_bytes)

Run Tests

# Run STATIC liveness tests only
pytest yoti_python_sdk/tests/doc_scan/session/create/check/test_liveness_check.py -v
pytest yoti_python_sdk/tests/doc_scan/session/retrieve/test_static_liveness_resource.py -v

# Run all doc_scan tests
pytest yoti_python_sdk/tests/doc_scan/ -v

Example Application

The Flask example application (examples/doc_scan/) now displays Static Liveness resources on the success page:

Shows resource ID and liveness type
Displays the static liveness image
Provides media ID for reference
Uses collapsible accordion UI similar to ZOOM liveness

Backward Compatibility

✅ Fully backward compatible - All existing code using ZOOM liveness continues to work without any changes:

# Existing ZOOM liveness code still works
zoom_check = RequestedLivenessCheckBuilder().for_zoom_liveness().build()
zoom_resources = session_result.resources.zoom_liveness_resources

# New STATIC liveness code
static_check = RequestedLivenessCheckBuilder().for_static_liveness().build()
static_resources = session_result.resources.static_liveness_resources

Acceptance Criteria

All three acceptance criteria have been met:

✅ Add support for requesting a liveness check type STATIC
- Implemented via for_static_liveness() builder method
- Supports manual_check parameter (defaults to "NEVER")
✅ Add support for retrieving the updated liveness check response
- Created StaticLivenessResourceResponse class
- Added static_liveness_resources filter property
- Parses image and media objects correctly
✅ Ensure that the SDKs support retrieving the media for the STATIC liveness check
- Media ID accessible via resource.image.media.id
- Existing get_media_content() method works seamlessly
- Example application displays the image

For Existing Implementations

No changes required! Your existing ZOOM liveness code will continue to work. You can optionally add STATIC liveness support:

# Add STATIC liveness alongside existing ZOOM liveness
session_spec = (
    SessionSpecBuilder()
    .with_requested_check(
        RequestedLivenessCheckBuilder()
        .for_zoom_liveness()  # Existing
        .with_max_retries(1)
        .build()
    )
    .with_requested_check(
        RequestedLivenessCheckBuilder()
        .for_static_liveness()  # New
        .with_max_retries(3)
        .with_manual_check_never()
        .build()
    )
    # ... other configuration
    .build()
)

Merge master 1.14.0 → development

Bumps [protobuf](https://github.com/protocolbuffers/protobuf) from 3.13.0 to 3.14.0. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/master/generate_changelog.py) - [Commits](protocolbuffers/protobuf@v3.13.0...v3.14.0) Signed-off-by: dependabot[bot] <[email protected]>

NA: Update dependabot reviewers

Bumps [cffi](https://github.com/python-cffi/release-doc) from 1.14.3 to 1.14.4. - [Release notes](https://github.com/python-cffi/release-doc/releases) - [Commits](https://github.com/python-cffi/release-doc/commits) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.1.0 to 20.2.1. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.1.0...20.2.1) Signed-off-by: dependabot[bot] <[email protected]>

SDK-1583: Merge GitHub actions CI steps into development

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.2.1 to 20.4.3. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.2.1...20.4.3) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [pytz](https://github.com/stub42/pytz) from 2020.4 to 2021.1. - [Release notes](https://github.com/stub42/pytz/releases) - [Commits](stub42/pytz@release_2020.4...release_2021.1) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [iso8601](https://github.com/micktwomey/pyiso8601) from 0.1.13 to 0.1.14. - [Release notes](https://github.com/micktwomey/pyiso8601/releases) - [Commits](micktwomey/pyiso8601@0.1.13...0.1.14) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [deprecated](https://github.com/tantale/deprecated) from 1.2.10 to 1.2.12. - [Release notes](https://github.com/tantale/deprecated/releases) - [Changelog](https://github.com/tantale/deprecated/blob/master/CHANGELOG.rst) - [Commits](laurent-laporte-pro/deprecated@v1.2.10...v1.2.12) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [protobuf](https://github.com/protocolbuffers/protobuf) from 3.14.0 to 3.15.8. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/master/generate_changelog.py) - [Commits](protocolbuffers/protobuf@v3.14.0...v3.15.8) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [cffi](https://github.com/python-cffi/release-doc) from 1.14.4 to 1.14.5. - [Release notes](https://github.com/python-cffi/release-doc/releases) - [Commits](https://github.com/python-cffi/release-doc/commits) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [protobuf](https://github.com/protocolbuffers/protobuf) from 3.15.8 to 3.17.1. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/master/generate_changelog.py) - [Commits](protocolbuffers/protobuf@v3.15.8...v3.17.1) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [werkzeug](https://github.com/pallets/werkzeug) from 1.0.1 to 2.0.1. - [Release notes](https://github.com/pallets/werkzeug/releases) - [Changelog](https://github.com/pallets/werkzeug/blob/main/CHANGES.rst) - [Commits](pallets/werkzeug@1.0.1...2.0.1) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.4.3 to 20.4.7. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.4.3...20.4.7) Signed-off-by: dependabot[bot] <[email protected]>

Bumps [protobuf](https://github.com/protocolbuffers/protobuf) from 3.17.1 to 3.17.3. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/master/generate_changelog.py) - [Commits](protocolbuffers/protobuf@v3.17.1...v3.17.3) --- updated-dependencies: - dependency-name: protobuf dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

# Conflicts: # examples/yoti_example_django/requirements.txt

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.4.7 to 20.7.2. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.4.7...20.7.2) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [cffi](http://cffi.readthedocs.org) from 1.14.5 to 1.14.6. --- updated-dependencies: - dependency-name: cffi dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [iso8601](https://github.com/micktwomey/pyiso8601) from 0.1.14 to 0.1.16. - [Release notes](https://github.com/micktwomey/pyiso8601/releases) - [Commits](micktwomey/pyiso8601@0.1.14...0.1.16) --- updated-dependencies: - dependency-name: iso8601 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.7.2 to 20.8.1. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.7.2...20.8.1) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [deprecated](https://github.com/tantale/deprecated) from 1.2.12 to 1.2.13. - [Release notes](https://github.com/tantale/deprecated/releases) - [Changelog](https://github.com/tantale/deprecated/blob/master/CHANGELOG.rst) - [Commits](laurent-laporte-pro/deprecated@v1.2.12...v1.2.13) --- updated-dependencies: - dependency-name: deprecated dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

SDK-2027: adding non-latin support for session and supported documents

SDK-1901: Adding WATCHLIST_SCREENING check

SDK-1838 auth_type for doc_scan session

Bumps [pytz](https://github.com/stub42/pytz) from 2021.1 to 2021.3. - [Release notes](https://github.com/stub42/pytz/releases) - [Commits](stub42/pytz@release_2021.1...release_2021.3) --- updated-dependencies: - dependency-name: pytz dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.12.0 to 20.13.0. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.12.0...20.13.0) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [protobuf](https://github.com/protocolbuffers/protobuf) from 3.19.3 to 3.19.4. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/master/generate_changelog.py) - [Commits](protocolbuffers/protobuf@v3.19.3...v3.19.4) --- updated-dependencies: - dependency-name: protobuf dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

# Conflicts: # .github/workflows/tests.yaml # .pre-commit-config.yaml # examples/yoti_example_flask/requirements.in # examples/yoti_example_flask/requirements.txt # requirements.in # requirements.txt # setup.py # sonar-project.properties # yoti_python_sdk/version.py

Bumps [pip-tools](https://github.com/jazzband/pip-tools) from 6.4.0 to 6.6.2. - [Release notes](https://github.com/jazzband/pip-tools/releases) - [Changelog](https://github.com/jazzband/pip-tools/blob/master/CHANGELOG.md) - [Commits](jazzband/pip-tools@6.4.0...6.6.2) --- updated-dependencies: - dependency-name: pip-tools dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.13.0 to 20.14.1. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.13.0...20.14.1) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [werkzeug](https://github.com/pallets/werkzeug) from 2.0.2 to 2.1.2. - [Release notes](https://github.com/pallets/werkzeug/releases) - [Changelog](https://github.com/pallets/werkzeug/blob/main/CHANGES.rst) - [Commits](pallets/werkzeug@2.0.2...2.1.2) --- updated-dependencies: - dependency-name: werkzeug dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.14.1 to 20.15.1. - [Release notes](https://github.com/pypa/virtualenv/releases) - [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) - [Commits](pypa/virtualenv@20.14.1...20.15.1) --- updated-dependencies: - dependency-name: virtualenv dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Python library updates

* added python static liveness check

davidgrayston and others added 30 commits November 16, 2020 16:21

Update demo SDK version

597b730

Bump minor version

412820e

Merge pull request #273 from getyoti/master-1.14.0

d4eebfb

Merge master 1.14.0 → development

SDK-1825: Add support for custom privacy policy URL

4102733

Merge pull request #276 from getyoti/master

24471eb

NA: Update dependabot reviewers

Merge pull request #288 from getyoti/master

7f8b1ed

SDK-1583: Merge GitHub actions CI steps into development

Bump pytz from 2020.4 to 2021.1

2a51312

Bumps [pytz](https://github.com/stub42/pytz) from 2020.4 to 2021.1. - [Release notes](https://github.com/stub42/pytz/releases) - [Commits](stub42/pytz@release_2020.4...release_2021.1) Signed-off-by: dependabot[bot] <[email protected]>

Bump iso8601 from 0.1.13 to 0.1.14

7e04b10

Bumps [iso8601](https://github.com/micktwomey/pyiso8601) from 0.1.13 to 0.1.14. - [Release notes](https://github.com/micktwomey/pyiso8601/releases) - [Commits](micktwomey/pyiso8601@0.1.13...0.1.14) Signed-off-by: dependabot[bot] <[email protected]>

Merge branch 'master' into development

8ed1890

# Conflicts: # examples/yoti_example_django/requirements.txt

adding myself to dependabot

885c7c6

Apply suggestions from code review

0691db9

Bump cffi from 1.14.5 to 1.14.6

22907cb

Bumps [cffi](http://cffi.readthedocs.org) from 1.14.5 to 1.14.6. --- updated-dependencies: - dependency-name: cffi dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>

Update supported Python versions: add later versions and remove 2.7

c0bfbdb

Update pre-commit, use specific versions rather than floating branch

91bb167

Remove travis, update references to point to Github workflow

aa9e162

echarrod and others added 30 commits January 12, 2022 13:28

Add wheel to setup.py

052066d

pip install wheel

af033f0

Update django

7bffc05

Remove django check (for now)

c4cd552

Remove doc_scan check: problem with cffi & Python 3.10

d685ba9

Update requirements.txt

b269b24

SDK-2027: adding non-latin support for session and supported documents

fad2ce8

Merge pull request #347 from getyoti/feat/non_latin_documents

9af34b3

SDK-2027: adding non-latin support for session and supported documents

Merge pull request #321 from getyoti/feature/watchlist

20c7c02

SDK-1901: Adding WATCHLIST_SCREENING check

Merge pull request #324 from getyoti/feature/extend_auth_type

11224fc

SDK-1838 auth_type for doc_scan session

Update dependabot assignees

4c73bce

Revert adding of strictly_latin to source constraints builder

88f1461

Reinstate missing Github actions linting step

5ba6408

Update "check examples" steps

4c0658b

&& pip install --upgrade pip

39e323d

Run on Python 3.9

99d7650

Update jinja package (from Flask)

0298997

Remove tests after removing associated code

66a167c

Merge release/2.15.0 -> development

8e89f01

Merge branch 'master' into development

64083ed

Merge pull request #417 from getyoti/python-library-updates

0441863

Python library updates

added python static liveness check (#425)

d1d8e58

* added python static liveness check

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release/2.14.5 #436

Release/2.14.5 #436

Uh oh!

mehmet-yoti commented Dec 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Release/2.14.5 #436

Are you sure you want to change the base?

Release/2.14.5 #436

Uh oh!

Conversation

mehmet-yoti commented Dec 1, 2025

Static Liveness Check Implementation

Overview

Features Added

1. Session Creation (Request Side)

Create STATIC Liveness Check

2. Session Retrieval (Response Side)

Access STATIC Liveness Resources

3. Media Content Retrieval

Download STATIC Liveness Image

Run Tests

Example Application

Backward Compatibility

Acceptance Criteria

For Existing Implementations

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants